<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>AbstractDeveloperHelperService xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../../../apidocs/org/sakaiproject/entitybus/util/devhelper/AbstractDeveloperHelperService.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * $Id: AbstractDeveloperHelperService.html 12 2009-01-29 12:00:24Z azeckoski $</em>
<a name="3" href="#3">3</a>   <em> * $URL: http://entitybus.googlecode.com/svn/maven/site/entitybus-utils/xref/org/sakaiproject/entitybus/util/devhelper/AbstractDeveloperHelperService.html $</em>
<a name="4" href="#4">4</a>   <em> * DeveloperHelperServiceImpl.java - entity-broker - Apr 13, 2008 6:30:08 PM - azeckoski</em>
<a name="5" href="#5">5</a>   <em> **************************************************************************</em>
<a name="6" href="#6">6</a>   <em> * Copyright (c) 2008 Sakai Foundation</em>
<a name="7" href="#7">7</a>   <em> *</em>
<a name="8" href="#8">8</a>   <em> * Licensed under the Educational Community License, Version 2.0 (the "License");</em>
<a name="9" href="#9">9</a>   <em> * you may not use this file except in compliance with the License.</em>
<a name="10" href="#10">10</a>  <em> * You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em> *</em>
<a name="12" href="#12">12</a>  <em> *       <a href="http://www.osedu.org/licenses/ECL-2.0" target="alexandria_uri">http://www.osedu.org/licenses/ECL-2.0</a></em>
<a name="13" href="#13">13</a>  <em> *</em>
<a name="14" href="#14">14</a>  <em> * Unless required by applicable law or agreed to in writing, software</em>
<a name="15" href="#15">15</a>  <em> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="16" href="#16">16</a>  <em> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="17" href="#17">17</a>  <em> * See the License for the specific language governing permissions and</em>
<a name="18" href="#18">18</a>  <em> * limitations under the License.</em>
<a name="19" href="#19">19</a>  <em> */</em>
<a name="20" href="#20">20</a>  
<a name="21" href="#21">21</a>  <strong>package</strong> org.sakaiproject.entitybus.util.devhelper;
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  <strong>import</strong> java.lang.ref.WeakReference;
<a name="24" href="#24">24</a>  <strong>import</strong> java.util.HashMap;
<a name="25" href="#25">25</a>  <strong>import</strong> java.util.List;
<a name="26" href="#26">26</a>  <strong>import</strong> java.util.Locale;
<a name="27" href="#27">27</a>  <strong>import</strong> java.util.Map;
<a name="28" href="#28">28</a>  
<a name="29" href="#29">29</a>  <strong>import</strong> org.apache.commons.logging.Log;
<a name="30" href="#30">30</a>  <strong>import</strong> org.apache.commons.logging.LogFactory;
<a name="31" href="#31">31</a>  <strong>import</strong> org.azeckoski.reflectutils.ReflectUtils;
<a name="32" href="#32">32</a>  <strong>import</strong> org.azeckoski.reflectutils.transcoders.HTMLTranscoder;
<a name="33" href="#33">33</a>  <strong>import</strong> org.azeckoski.reflectutils.transcoders.JSONTranscoder;
<a name="34" href="#34">34</a>  <strong>import</strong> org.azeckoski.reflectutils.transcoders.Transcoder;
<a name="35" href="#35">35</a>  <strong>import</strong> org.azeckoski.reflectutils.transcoders.XMLTranscoder;
<a name="36" href="#36">36</a>  <strong>import</strong> org.sakaiproject.entitybus.DeveloperHelperService;
<a name="37" href="#37">37</a>  <strong>import</strong> org.sakaiproject.entitybus.EntityBroker;
<a name="38" href="#38">38</a>  <strong>import</strong> org.sakaiproject.entitybus.EntityBrokerManager;
<a name="39" href="#39">39</a>  <strong>import</strong> org.sakaiproject.entitybus.EntityReference;
<a name="40" href="#40">40</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.Formats;
<a name="41" href="#41">41</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.RequestStorage;
<a name="42" href="#42">42</a>  <strong>import</strong> org.sakaiproject.entitybus.providers.EntityPropertiesService;
<a name="43" href="#43">43</a>  <strong>import</strong> org.sakaiproject.entitybus.providers.EntityRESTProvider;
<a name="44" href="#44">44</a>  
<a name="45" href="#45">45</a>  <em>/**<em>*</em></em>
<a name="46" href="#46">46</a>  <em> * implementation of the helper service methods which are internal only</em>
<a name="47" href="#47">47</a>  <em> * NOTE: you should probably override encode and decode data rather than simply using the current impl</em>
<a name="48" href="#48">48</a>  <em> * </em>
<a name="49" href="#49">49</a>  <em> * @author Aaron Zeckoski (aaron@caret.cam.ac.uk)</em>
<a name="50" href="#50">50</a>  <em> */</em>
<a name="51" href="#51">51</a>  <strong>public</strong> <strong>abstract</strong> <strong>class</strong> <a href="../../../../../org/sakaiproject/entitybus/util/devhelper/AbstractDeveloperHelperService.html">AbstractDeveloperHelperService</a> implements DeveloperHelperService {
<a name="52" href="#52">52</a>  
<a name="53" href="#53">53</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> Log log = LogFactory.getLog(AbstractDeveloperHelperService.<strong>class</strong>);
<a name="54" href="#54">54</a>  
<a name="55" href="#55">55</a>      <em>/**<em>*</em></em>
<a name="56" href="#56">56</a>  <em>     * EMPTY - do not use</em>
<a name="57" href="#57">57</a>  <em>     */</em>
<a name="58" href="#58">58</a>      <strong>public</strong> <a href="../../../../../org/sakaiproject/entitybus/util/devhelper/AbstractDeveloperHelperService.html">AbstractDeveloperHelperService</a>() { <strong>super</strong>(); }
<a name="59" href="#59">59</a>  
<a name="60" href="#60">60</a>      <em>/**<em>*</em></em>
<a name="61" href="#61">61</a>  <em>     * MINIMAL</em>
<a name="62" href="#62">62</a>  <em>     * @param entityBroker the main EntityBroker service</em>
<a name="63" href="#63">63</a>  <em>     * @param entityBrokerManager the main EB manager service</em>
<a name="64" href="#64">64</a>  <em>     */</em>
<a name="65" href="#65">65</a>      <strong>public</strong> <a href="../../../../../org/sakaiproject/entitybus/util/devhelper/AbstractDeveloperHelperService.html">AbstractDeveloperHelperService</a>(EntityBroker entityBroker,
<a name="66" href="#66">66</a>              EntityBrokerManager entityBrokerManager) {
<a name="67" href="#67">67</a>          <strong>super</strong>();
<a name="68" href="#68">68</a>          <strong>this</strong>.entityBroker = entityBroker;
<a name="69" href="#69">69</a>          <strong>this</strong>.entityBrokerManager = entityBrokerManager;
<a name="70" href="#70">70</a>          <strong>this</strong>.requestStorage = entityBrokerManager.getRequestStorage();
<a name="71" href="#71">71</a>          <strong>this</strong>.entityProperties = entityBrokerManager.getEntityPropertiesService();
<a name="72" href="#72">72</a>      }
<a name="73" href="#73">73</a>  
<a name="74" href="#74">74</a>      <em class="comment">// weak ref to ensure we do not hold anything open</em>
<a name="75" href="#75">75</a>      <strong>protected</strong> WeakReference&lt;EntityRESTProvider> entityRESTProviderWeak;
<a name="76" href="#76">76</a>      <strong>public</strong> EntityRESTProvider getEntityRESTProvider() {
<a name="77" href="#77">77</a>          EntityRESTProvider erp = <strong>null</strong>;
<a name="78" href="#78">78</a>          <strong>if</strong> (<strong>this</strong>.entityRESTProviderWeak == <strong>null</strong>) {
<a name="79" href="#79">79</a>              setEntityRESTProvider( <strong>this</strong>.entityBrokerManager.getEntityRESTProvider() );
<a name="80" href="#80">80</a>          }
<a name="81" href="#81">81</a>          <strong>return</strong> erp;
<a name="82" href="#82">82</a>      }
<a name="83" href="#83">83</a>      <em>/**<em>*</em></em>
<a name="84" href="#84">84</a>  <em>     * Set this to include an optional encoding/decoding handler</em>
<a name="85" href="#85">85</a>  <em>     * @param entityRESTProvider the encoding manager service</em>
<a name="86" href="#86">86</a>  <em>     */</em>
<a name="87" href="#87">87</a>      <strong>public</strong> <strong>void</strong> setEntityRESTProvider(EntityRESTProvider entityRESTProvider) {
<a name="88" href="#88">88</a>          <strong>if</strong> (entityRESTProvider != <strong>null</strong>) {
<a name="89" href="#89">89</a>              <strong>this</strong>.entityRESTProviderWeak = <strong>new</strong> WeakReference&lt;EntityRESTProvider>(entityRESTProvider);
<a name="90" href="#90">90</a>          } <strong>else</strong> {
<a name="91" href="#91">91</a>              <strong>this</strong>.entityRESTProviderWeak = <strong>null</strong>;
<a name="92" href="#92">92</a>          }
<a name="93" href="#93">93</a>      }
<a name="94" href="#94">94</a>  
<a name="95" href="#95">95</a>      <em class="comment">// ENCODING / DECODING</em>
<a name="96" href="#96">96</a>  
<a name="97" href="#97">97</a>      <strong>public</strong> Map&lt;String, Object> decodeData(String data, String format) {
<a name="98" href="#98">98</a>          <strong>if</strong> (format == <strong>null</strong>) {
<a name="99" href="#99">99</a>              format = Formats.XML;
<a name="100" href="#100">100</a>         }
<a name="101" href="#101">101</a>         Map&lt;String, Object> decoded = <strong>new</strong> HashMap&lt;String, Object>(0);
<a name="102" href="#102">102</a>         <strong>if</strong> (getEntityRESTProvider() == <strong>null</strong>) {
<a name="103" href="#103">103</a>             log.warn(<span class="string">"No entityRESTProvider available for decoding, using basic internal decoder"</span>);
<a name="104" href="#104">104</a>             <strong>if</strong> (data != <strong>null</strong>) {
<a name="105" href="#105">105</a>                 Transcoder transcoder = getTranscoder(format);
<a name="106" href="#106">106</a>                 <strong>try</strong> {
<a name="107" href="#107">107</a>                     decoded = transcoder.decode(data);
<a name="108" href="#108">108</a>                 } <strong>catch</strong> (RuntimeException e) {
<a name="109" href="#109">109</a>                     <em class="comment">// convert failure to UOE</em>
<a name="110" href="#110">110</a>                     <strong>throw</strong> <strong>new</strong> UnsupportedOperationException(<span class="string">"Failure encoding data ("</span>+data+<span class="string">") of type ("</span>+data.getClass()+<span class="string">"): "</span> + e.getMessage(), e);
<a name="111" href="#111">111</a>                 }
<a name="112" href="#112">112</a>             }
<a name="113" href="#113">113</a>         } <strong>else</strong> {
<a name="114" href="#114">114</a>             decoded = getEntityRESTProvider().decodeData(data, format);
<a name="115" href="#115">115</a>         }
<a name="116" href="#116">116</a>         <strong>return</strong> decoded;
<a name="117" href="#117">117</a>     }
<a name="118" href="#118">118</a> 
<a name="119" href="#119">119</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="120" href="#120">120</a> <em class="comment">     * @see org.sakaiproject.entitybus.DeveloperHelperService#encodeData(java.lang.Object, java.lang.String, java.lang.String, java.util.Map)</em>
<a name="121" href="#121">121</a> <em class="comment">     */</em>
<a name="122" href="#122">122</a>     <strong>public</strong> String encodeData(Object data, String format, String name, Map&lt;String, Object> properties) {
<a name="123" href="#123">123</a>         <strong>if</strong> (format == <strong>null</strong>) {
<a name="124" href="#124">124</a>             format = Formats.XML;
<a name="125" href="#125">125</a>         }
<a name="126" href="#126">126</a>         String encoded = <span class="string">""</span>;
<a name="127" href="#127">127</a>         <strong>if</strong> (getEntityRESTProvider() == <strong>null</strong>) {
<a name="128" href="#128">128</a>             log.warn(<span class="string">"No entityRESTProvider available for encoding, using basic internal encoder"</span>);
<a name="129" href="#129">129</a>             <strong>if</strong> (data != <strong>null</strong>) {
<a name="130" href="#130">130</a>                 Transcoder transcoder = getTranscoder(format);
<a name="131" href="#131">131</a>                 <strong>try</strong> {
<a name="132" href="#132">132</a>                     encoded = transcoder.encode(data, name, properties);
<a name="133" href="#133">133</a>                 } <strong>catch</strong> (RuntimeException e) {
<a name="134" href="#134">134</a>                     <em class="comment">// convert failure to UOE</em>
<a name="135" href="#135">135</a>                     <strong>throw</strong> <strong>new</strong> UnsupportedOperationException(<span class="string">"Failure encoding data ("</span>+data+<span class="string">") of type ("</span>+data.getClass()+<span class="string">"): "</span> + e.getMessage(), e);
<a name="136" href="#136">136</a>                 }
<a name="137" href="#137">137</a>             }
<a name="138" href="#138">138</a>         } <strong>else</strong> {
<a name="139" href="#139">139</a>             encoded = getEntityRESTProvider().encodeData(data, format, name, properties);
<a name="140" href="#140">140</a>         }
<a name="141" href="#141">141</a>         <strong>return</strong> encoded;
<a name="142" href="#142">142</a>     }
<a name="143" href="#143">143</a> 
<a name="144" href="#144">144</a>     <em>/**<em>*</em></em>
<a name="145" href="#145">145</a> <em>     * Encoding method to use when URL encoding</em>
<a name="146" href="#146">146</a> <em>     */</em>
<a name="147" href="#147">147</a>     <strong>public</strong> <strong>static</strong> String URL_ENCODING = <span class="string">"UTF-8"</span>;
<a name="148" href="#148">148</a>     <em>/**<em>*</em></em>
<a name="149" href="#149">149</a> <em>     * The site reference base</em>
<a name="150" href="#150">150</a> <em>     */</em>
<a name="151" href="#151">151</a>     <strong>public</strong> <strong>static</strong> String GROUP_BASE = <span class="string">"/site/"</span>;
<a name="152" href="#152">152</a>     <em>/**<em>*</em></em>
<a name="153" href="#153">153</a> <em>     * The user reference base</em>
<a name="154" href="#154">154</a> <em>     */</em>
<a name="155" href="#155">155</a>     <strong>public</strong> <strong>static</strong> String USER_BASE = <span class="string">"/user/"</span>;
<a name="156" href="#156">156</a> 
<a name="157" href="#157">157</a>     <strong>protected</strong> <strong>final</strong> String CURRENT_USER_MARKER = <span class="string">"originalCurrentUser"</span>;
<a name="158" href="#158">158</a> 
<a name="159" href="#159">159</a>     <em class="comment">// INTERNAL</em>
<a name="160" href="#160">160</a>     <strong>public</strong> EntityBroker entityBroker;
<a name="161" href="#161">161</a>     <strong>public</strong> <strong>void</strong> setEntityBroker(EntityBroker entityBroker) {
<a name="162" href="#162">162</a>         <strong>this</strong>.entityBroker = entityBroker;
<a name="163" href="#163">163</a>     }
<a name="164" href="#164">164</a> 
<a name="165" href="#165">165</a>     <strong>public</strong> EntityBrokerManager entityBrokerManager;
<a name="166" href="#166">166</a>     <strong>public</strong> <strong>void</strong> setEntityBrokerManager(EntityBrokerManager entityBrokerManager) {
<a name="167" href="#167">167</a>         <strong>this</strong>.entityBrokerManager = entityBrokerManager;
<a name="168" href="#168">168</a>     }
<a name="169" href="#169">169</a> 
<a name="170" href="#170">170</a>     <strong>public</strong> RequestStorage requestStorage;
<a name="171" href="#171">171</a>     <strong>public</strong> <strong>void</strong> setRequestStorage(RequestStorage requestStorage) {
<a name="172" href="#172">172</a>         <strong>this</strong>.requestStorage = requestStorage;
<a name="173" href="#173">173</a>     }
<a name="174" href="#174">174</a> 
<a name="175" href="#175">175</a>     <strong>public</strong> EntityPropertiesService entityProperties;
<a name="176" href="#176">176</a>     <em>/**<em>*</em></em>
<a name="177" href="#177">177</a> <em>     * Set this to include an optional properties handler</em>
<a name="178" href="#178">178</a> <em>     * @param entityProperties</em>
<a name="179" href="#179">179</a> <em>     */</em>
<a name="180" href="#180">180</a>     <strong>public</strong> <strong>void</strong> setEntityProperties(EntityPropertiesService entityProperties) {
<a name="181" href="#181">181</a>         <strong>this</strong>.entityProperties = entityProperties;
<a name="182" href="#182">182</a>     }
<a name="183" href="#183">183</a> 
<a name="184" href="#184">184</a> 
<a name="185" href="#185">185</a>     <em class="comment">// ENTITY</em>
<a name="186" href="#186">186</a> 
<a name="187" href="#187">187</a>     <strong>public</strong> <strong>boolean</strong> entityExists(String reference) {
<a name="188" href="#188">188</a>         <strong>return</strong> entityBroker.entityExists(reference);
<a name="189" href="#189">189</a>     }
<a name="190" href="#190">190</a> 
<a name="191" href="#191">191</a>     <strong>public</strong> Object fetchEntity(String reference) {
<a name="192" href="#192">192</a>         Object entity = entityBroker.fetchEntity(reference);
<a name="193" href="#193">193</a>         <strong>return</strong> entity;
<a name="194" href="#194">194</a>     }
<a name="195" href="#195">195</a> 
<a name="196" href="#196">196</a>     <strong>public</strong> <strong>void</strong> fireEvent(String eventName, String reference) {
<a name="197" href="#197">197</a>         entityBroker.fireEvent(eventName, reference);
<a name="198" href="#198">198</a>     }
<a name="199" href="#199">199</a> 
<a name="200" href="#200">200</a>     <strong>public</strong> String getEntityURL(String reference, String viewKey, String extension) {
<a name="201" href="#201">201</a>         <strong>return</strong> entityBrokerManager.getEntityURL(reference, viewKey, extension);
<a name="202" href="#202">202</a>     }
<a name="203" href="#203">203</a> 
<a name="204" href="#204">204</a> 
<a name="205" href="#205">205</a>     <em class="comment">// CONFIG</em>
<a name="206" href="#206">206</a> 
<a name="207" href="#207">207</a>     <em class="comment">// USER</em>
<a name="208" href="#208">208</a> 
<a name="209" href="#209">209</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="210" href="#210">210</a> <em class="comment">     * @see org.sakaiproject.entitybus.DeveloperHelperService#getCurrentLocale()</em>
<a name="211" href="#211">211</a> <em class="comment">     */</em>
<a name="212" href="#212">212</a>     <strong>public</strong> Locale getCurrentLocale() {
<a name="213" href="#213">213</a>         <strong>return</strong> Locale.getDefault();
<a name="214" href="#214">214</a>     }
<a name="215" href="#215">215</a> 
<a name="216" href="#216">216</a>     <strong>public</strong> String getUserIdFromRef(String userReference) {
<a name="217" href="#217">217</a>         String userId = <strong>null</strong>;
<a name="218" href="#218">218</a>         <strong>if</strong> (userReference != <strong>null</strong>) {
<a name="219" href="#219">219</a>             <strong>if</strong> (userReference.startsWith(<span class="string">"/"</span>)) {
<a name="220" href="#220">220</a>                 <em class="comment">// assume the form of "/user/userId" (the UDS method is protected)</em>
<a name="221" href="#221">221</a>                 userId = <strong>new</strong> EntityReference(userReference).getId();
<a name="222" href="#222">222</a>             } <strong>else</strong> {
<a name="223" href="#223">223</a>                 <em class="comment">// otherwise assume this is the id</em>
<a name="224" href="#224">224</a>                 userId = userReference;
<a name="225" href="#225">225</a>             }
<a name="226" href="#226">226</a>         }
<a name="227" href="#227">227</a>         <strong>return</strong> userId;
<a name="228" href="#228">228</a>     }
<a name="229" href="#229">229</a> 
<a name="230" href="#230">230</a>     <strong>public</strong> String getUserRefFromUserId(String userId) {
<a name="231" href="#231">231</a>         String userRef = <strong>null</strong>;
<a name="232" href="#232">232</a>         <strong>if</strong> (userId != <strong>null</strong>) {
<a name="233" href="#233">233</a>             <em class="comment">// use the UDS method for controlling its references</em>
<a name="234" href="#234">234</a>             userRef = USER_BASE + userId;
<a name="235" href="#235">235</a>         }
<a name="236" href="#236">236</a>         <strong>return</strong> userRef;
<a name="237" href="#237">237</a>     }
<a name="238" href="#238">238</a> 
<a name="239" href="#239">239</a>     <strong>public</strong> String getCurrentUserReference() {
<a name="240" href="#240">240</a>         String userRef = <strong>null</strong>;
<a name="241" href="#241">241</a>         String userId = getCurrentUserId();
<a name="242" href="#242">242</a>         <strong>if</strong> (userId != <strong>null</strong>) {
<a name="243" href="#243">243</a>             userRef = USER_BASE + userId;
<a name="244" href="#244">244</a>         }
<a name="245" href="#245">245</a>         <strong>return</strong> userRef;
<a name="246" href="#246">246</a>     }
<a name="247" href="#247">247</a> 
<a name="248" href="#248">248</a>     <em class="comment">// LOCATION</em>
<a name="249" href="#249">249</a> 
<a name="250" href="#250">250</a>     <strong>public</strong> String getLocationIdFromRef(String locationReference) {
<a name="251" href="#251">251</a>         String locationId = <strong>null</strong>;
<a name="252" href="#252">252</a>         <strong>if</strong> (locationReference != <strong>null</strong>) {
<a name="253" href="#253">253</a>             <em class="comment">// assume the form of "/site/siteId" (the Site method is protected)</em>
<a name="254" href="#254">254</a>             locationId = <strong>new</strong> EntityReference(locationReference).getId();
<a name="255" href="#255">255</a>         }
<a name="256" href="#256">256</a>         <strong>return</strong> locationId;
<a name="257" href="#257">257</a>     }
<a name="258" href="#258">258</a> 
<a name="259" href="#259">259</a>     <strong>public</strong> String getCurrentLocationReference() {
<a name="260" href="#260">260</a>         String locRef = <strong>null</strong>;
<a name="261" href="#261">261</a>         String locId = getCurrentLocationId();
<a name="262" href="#262">262</a>         <strong>if</strong> (locId != <strong>null</strong>) {
<a name="263" href="#263">263</a>             locRef = GROUP_BASE + locId;
<a name="264" href="#264">264</a>         }
<a name="265" href="#265">265</a>         <strong>return</strong> locRef;
<a name="266" href="#266">266</a>     }
<a name="267" href="#267">267</a> 
<a name="268" href="#268">268</a>     <strong>public</strong> String getStartingLocationReference() {
<a name="269" href="#269">269</a>         <strong>return</strong> <span class="string">"/"</span>;
<a name="270" href="#270">270</a>     }
<a name="271" href="#271">271</a> 
<a name="272" href="#272">272</a>     <strong>public</strong> String getUserHomeLocationReference(String userReference) {
<a name="273" href="#273">273</a>         <strong>if</strong> (userReference == <strong>null</strong>) {
<a name="274" href="#274">274</a>             userReference = getCurrentUserReference();
<a name="275" href="#275">275</a>         }
<a name="276" href="#276">276</a>         String userId = getUserIdFromRef(userReference);
<a name="277" href="#277">277</a>         String locationRef = <strong>null</strong>;
<a name="278" href="#278">278</a>         <strong>if</strong> (userId != <strong>null</strong>) {
<a name="279" href="#279">279</a>             locationRef = GROUP_BASE + <span class="string">"~"</span> + userId; <em class="comment">// make this manually</em>
<a name="280" href="#280">280</a>         } <strong>else</strong> {
<a name="281" href="#281">281</a>             log.warn(<span class="string">"Cannot get the userhome locationReference because there is no current user: "</span> + userReference);
<a name="282" href="#282">282</a>         }
<a name="283" href="#283">283</a>         <strong>return</strong> locationRef;
<a name="284" href="#284">284</a>     }
<a name="285" href="#285">285</a> 
<a name="286" href="#286">286</a>     <em class="comment">// TOOLS</em>
<a name="287" href="#287">287</a> 
<a name="288" href="#288">288</a>     <strong>public</strong> String getToolIdFromToolRef(String toolReference) {
<a name="289" href="#289">289</a>         String toolId = <strong>null</strong>;
<a name="290" href="#290">290</a>         <strong>if</strong> (toolReference != <strong>null</strong>) {
<a name="291" href="#291">291</a>             toolId = <strong>new</strong> EntityReference(toolReference).getId();
<a name="292" href="#292">292</a>         }
<a name="293" href="#293">293</a>         <strong>return</strong> toolId;
<a name="294" href="#294">294</a>     }
<a name="295" href="#295">295</a> 
<a name="296" href="#296">296</a>     <em class="comment">// URLS</em>
<a name="297" href="#297">297</a> 
<a name="298" href="#298">298</a>     <strong>public</strong> String getUserHomeLocationURL(String userReference) {
<a name="299" href="#299">299</a>         String locationReference = getUserHomeLocationReference(userReference);
<a name="300" href="#300">300</a>         <strong>if</strong> (locationReference == <strong>null</strong>) {
<a name="301" href="#301">301</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Could not get location from userReference ("</span>+userReference+<span class="string">") to generate URL"</span>);
<a name="302" href="#302">302</a>         }
<a name="303" href="#303">303</a>         <strong>return</strong> getLocationReferenceURL(locationReference);
<a name="304" href="#304">304</a>     }
<a name="305" href="#305">305</a> 
<a name="306" href="#306">306</a>     <strong>public</strong> String getLocationReferenceURL(String locationReference) {
<a name="307" href="#307">307</a>         <strong>new</strong> EntityReference(locationReference); <em class="comment">// validate the reference</em>
<a name="308" href="#308">308</a>         <strong>return</strong> getPortalURL() + locationReference;
<a name="309" href="#309">309</a>     }
<a name="310" href="#310">310</a> 
<a name="311" href="#311">311</a>     <em class="comment">// PERMISSIONS</em>
<a name="312" href="#312">312</a> 
<a name="313" href="#313">313</a>     <em>/**<em>*</em></em>
<a name="314" href="#314">314</a> <em>     * Checks to see if a request is internal and therefore can bypass some or all security</em>
<a name="315" href="#315">315</a> <em>     * @param reference an entity reference string</em>
<a name="316" href="#316">316</a> <em>     * @return true if internal OR false if external or REST</em>
<a name="317" href="#317">317</a> <em>     */</em>
<a name="318" href="#318">318</a>     <strong>public</strong> <strong>boolean</strong> isEntityRequestInternal(String reference) {
<a name="319" href="#319">319</a>         <strong>boolean</strong> internal = false;
<a name="320" href="#320">320</a>         String origin = (String) requestStorage.getStoredValue(RequestStorage.ReservedKeys._requestOrigin.name());
<a name="321" href="#321">321</a>         <strong>if</strong> (RequestStorage.RequestOrigin.INTERNAL.name().equals(origin)) {
<a name="322" href="#322">322</a>             internal = <strong>true</strong>;
<a name="323" href="#323">323</a>         } <strong>else</strong> {
<a name="324" href="#324">324</a>             <strong>if</strong> (reference != <strong>null</strong>) {
<a name="325" href="#325">325</a>                 String ref = (String) requestStorage.getStoredValue(RequestStorage.ReservedKeys._requestEntityReference.name());
<a name="326" href="#326">326</a>                 <strong>if</strong> (reference.equals(ref)) {
<a name="327" href="#327">327</a>                     <em class="comment">// if this ref was the one requested from outside it is definitely not internal</em>
<a name="328" href="#328">328</a>                     internal = false;
<a name="329" href="#329">329</a>                 } <strong>else</strong> {
<a name="330" href="#330">330</a>                     internal = <strong>true</strong>;
<a name="331" href="#331">331</a>                 }
<a name="332" href="#332">332</a>             }
<a name="333" href="#333">333</a>         }
<a name="334" href="#334">334</a>         <strong>return</strong> internal;
<a name="335" href="#335">335</a>     }
<a name="336" href="#336">336</a> 
<a name="337" href="#337">337</a>     <em class="comment">// BEANS</em>
<a name="338" href="#338">338</a> 
<a name="339" href="#339">339</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="340" href="#340">340</a> <em class="comment">     * @see org.sakaiproject.entitybus.DeveloperHelperService#cloneBean(java.lang.Object, int, java.lang.String[])</em>
<a name="341" href="#341">341</a> <em class="comment">     */</em>
<a name="342" href="#342">342</a>     <strong>public</strong> &lt;T> T cloneBean(T bean, <strong>int</strong> maxDepth, String[] propertiesToSkip) {
<a name="343" href="#343">343</a>         <strong>return</strong> ReflectUtils.getInstance().clone(bean, maxDepth, propertiesToSkip);
<a name="344" href="#344">344</a>     }
<a name="345" href="#345">345</a> 
<a name="346" href="#346">346</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="347" href="#347">347</a> <em class="comment">     * @see org.sakaiproject.entitybus.DeveloperHelperService#copyBean(java.lang.Object, java.lang.Object, int, java.lang.String[], boolean)</em>
<a name="348" href="#348">348</a> <em class="comment">     */</em>
<a name="349" href="#349">349</a>     <strong>public</strong> <strong>void</strong> copyBean(Object orig, Object dest, <strong>int</strong> maxDepth, String[] fieldNamesToSkip,
<a name="350" href="#350">350</a>             <strong>boolean</strong> ignoreNulls) {
<a name="351" href="#351">351</a>         ReflectUtils.getInstance().copy(orig, dest, maxDepth, fieldNamesToSkip, ignoreNulls);
<a name="352" href="#352">352</a>     }
<a name="353" href="#353">353</a> 
<a name="354" href="#354">354</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="355" href="#355">355</a> <em class="comment">     * @see org.sakaiproject.entitybus.DeveloperHelperService#populate(java.lang.Object, java.util.Map)</em>
<a name="356" href="#356">356</a> <em class="comment">     */</em>
<a name="357" href="#357">357</a>     <strong>public</strong> List&lt;String> populate(Object object, Map&lt;String, Object> properties) {
<a name="358" href="#358">358</a>         <strong>return</strong> ReflectUtils.getInstance().populate(object, properties);
<a name="359" href="#359">359</a>     }
<a name="360" href="#360">360</a> 
<a name="361" href="#361">361</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="362" href="#362">362</a> <em class="comment">     * @see org.sakaiproject.entitybus.DeveloperHelperService#convert(java.lang.Object, java.lang.Class)</em>
<a name="363" href="#363">363</a> <em class="comment">     */</em>
<a name="364" href="#364">364</a>     <strong>public</strong> &lt;T> T convert(Object object, Class&lt;T> type) {
<a name="365" href="#365">365</a>         <strong>return</strong> ReflectUtils.getInstance().convert(object, type);
<a name="366" href="#366">366</a>     }
<a name="367" href="#367">367</a> 
<a name="368" href="#368">368</a> 
<a name="369" href="#369">369</a>     <strong>private</strong> Map&lt;String, Transcoder> transcoders;
<a name="370" href="#370">370</a>     <strong>private</strong> Transcoder getTranscoder(String format) {
<a name="371" href="#371">371</a>         <strong>if</strong> (transcoders == <strong>null</strong>) {
<a name="372" href="#372">372</a>             transcoders = <strong>new</strong> HashMap&lt;String, Transcoder>();
<a name="373" href="#373">373</a>             JSONTranscoder jt = <strong>new</strong> JSONTranscoder(<strong>true</strong>, <strong>true</strong>, false);
<a name="374" href="#374">374</a>             transcoders.put(jt.getHandledFormat(), jt);
<a name="375" href="#375">375</a>             XMLTranscoder xt = <strong>new</strong> XMLTranscoder(<strong>true</strong>, <strong>true</strong>, false, false);
<a name="376" href="#376">376</a>             transcoders.put(xt.getHandledFormat(), xt);
<a name="377" href="#377">377</a>             HTMLTranscoder ht = <strong>new</strong> HTMLTranscoder();
<a name="378" href="#378">378</a>             transcoders.put(ht.getHandledFormat(), ht);
<a name="379" href="#379">379</a>         }
<a name="380" href="#380">380</a>         Transcoder transcoder = transcoders.get(format);
<a name="381" href="#381">381</a>         <strong>if</strong> (transcoder == <strong>null</strong>) {
<a name="382" href="#382">382</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Failed to find a transcoder for format, none exists, cannot encode or decode data for format: "</span> + format);
<a name="383" href="#383">383</a>         }
<a name="384" href="#384">384</a>         <strong>return</strong> transcoder;
<a name="385" href="#385">385</a>     }
<a name="386" href="#386">386</a> 
<a name="387" href="#387">387</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="388" href="#388">388</a> <em class="comment">     * @see org.sakaiproject.entitybus.DeveloperHelperService#getMessage(java.lang.String, java.lang.String)</em>
<a name="389" href="#389">389</a> <em class="comment">     */</em>
<a name="390" href="#390">390</a>     <strong>public</strong> String getMessage(String prefix, String messageKey) {
<a name="391" href="#391">391</a>         <strong>if</strong> (entityProperties == <strong>null</strong>) {
<a name="392" href="#392">392</a>             <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"No entityPropertiesHandler available for retrieving properties strings"</span>);
<a name="393" href="#393">393</a>         }
<a name="394" href="#394">394</a>         <strong>return</strong> entityProperties.getProperty(prefix, messageKey);
<a name="395" href="#395">395</a>     }
<a name="396" href="#396">396</a> 
<a name="397" href="#397">397</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

